PyramidViewUserObject

The user object contains all relevant meta-data for the user.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

id

The user's system ID.

Y

string

uuid

userName

The login username for the user

 -

string

firstName

The user's first name

 -

string

lastName

The user's last name

 -

string

email

The user's email

 -

string

phone

The user's phone

 -

string

proxyAccount

The user's proxy account needed for connecting to different data sources

 -

string

adminType

The user's administration level using the admin type enumeration

 -

AdminType

roleIds

The user's list of roles

 -

array

clientLicenseType

The user license type enumeration.

 -

ClientLicenseType

statusID

The user's status flag.

 -

UserStatusID

tenantId

The user's tenant ID

 -

string

createdDate

 -

integer

int64

lastLoginDate

 -

integer

int64

adDomainName

The AD/LDAP domain name (relevant in case the user is authenticated using AD)

 -

string

principalName

The user's SAML identifier (relevant in case the user is authenticated using SAML)

 -

string

*Required elements are only used for API parameters

Usages
  • /API2/access/getAllUsersDataByTenantAndLicenceType
  • /API2/access/getMe
  • /API2/access/getUser
  • /API2/access/getUserBySamlPrincipalName
  • /API2/access/getUsersByName
  • /API2/access/getUsersByRole